Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make backend docs work with vitepress #98

Merged
merged 2 commits into from
Sep 23, 2023
Merged

Make backend docs work with vitepress #98

merged 2 commits into from
Sep 23, 2023

Conversation

twynb
Copy link
Owner

@twynb twynb commented Sep 22, 2023

Add logic to change the markdown files generated by sphinx to work with vitepress.

After generating, the files are immediately updated so their file names no longer contain . (instead replaced with _) and links inside the files are updated to link to the corresponding new file names.

Only the markdown docs are affected, the HTML docs are not.

@twynb twynb self-assigned this Sep 22, 2023
docs/generate_docs.py Show resolved Hide resolved
docs/generate_docs.py Show resolved Hide resolved
@twynb twynb requested a review from 4lex0017 September 22, 2023 21:18
@twynb twynb merged commit efc8f59 into main Sep 23, 2023
1 check passed
@chubetho chubetho deleted the fix-backend-docs branch September 23, 2023 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants